Users

>>>

GET /api/admin/v1/users
List of users

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "users": [
    {
      "id": 9,
      "full_name": "Vadim Kruchina",
      "email": "kruchina.vadim@gmail.com",
      "invited_users_to_workspace_count": 2,
      "created_at": "2022-10-07T12:27:41.728Z",
      "presets_count": 0,
      "pictures_count": 0,
      "template_videos_count": 0,
      "content_requests_count": 2,
      "content_request_submissions_count": 5,
      "reset_workspace_invite_link": null,
      "workspace_admin": "N/A",
      "fieldhouse_user": false,
      "teams": [
        {
          "id": 4,
          "team_role": "admin"
        },
        {
          "id": 5,
          "team_role": "memder"
        },
        ...
      ],
      "workspace_role": {
        "id": 5,
        "name": "owner"
      },
      "workspace": {
        "id": 2,
        "name": "Scrum Launch",
        "plan": [
          "pro-bundle"
        ]
      }
    },
    ...
  ],
  "meta": {
    "total_count": 8
  }
}

Params

Param name Description
query
optional

Validations:

  • Must be a String
by_workspace
optional

Validations:

  • Must be one of: true, false, 1, 0.
workspace_id
optional

Validations:

  • Must be a Integer
sort_to
optional

Validations:

  • Must be one of: asc, desc.
sort_by
optional

Validations:

  • Must be one of: id, email, organization_name, created_at.
page
optional

Validations:

  • Must be a Integer
>>>

PUT /api/admin/v1/users/:id
Update user

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer
admin_password
optional

Validations:

  • Must be a String
password
optional

Validations:

  • Must be a String
role
optional

Validations:

  • Must be one of: , admin, super_admin.
fieldhouse_user
optional

Validations:

  • Must be one of: true, false, 1, 0.
>>>

DELETE /api/admin/v1/users/:id
Delete user

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer
>>>

GET /api/admin/v1/users/:id/resend_invite
Resend invite

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer